##########################################################################
##                                                        TM1pedia                                                                  ##
##                                             Volume 1 - TM1 Objects                                                    ##
##                                                                                                                                            ##
##                                                Created by D Turner                                                       ##
##                                                       20 JUNE 2007                                                              ##
##########################################################################

! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! DISCLAIMER ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! 
! !  The TM1pedia contains VBA macros which could potentially harm your           ! !
! !  system and / or TM1 installation. This product is not guaranteed or                  ! !
! !  supported by the author or Applix. USE AT YOUR OWN RISK.                                 ! !
! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! 

Versions
==========================================================================

1.0	20 JUN 07		Creation
1.1	20 JUN 07		Removed all hard coded references to "tm1serv:"
			Disabled ScreenUpdating during macro execution
			Corrected "Indices"
1.2	25 JUN 07		Fixed error generated if number of cubes/dimensions/processes/chores is 1 or less
			Removed "hard coded" source file names from "Where Used" tabs
1.3	26 JUN 07		Added capability to link to cube/dimension tabs from process source hyperlink

Setup
==========================================================================

1) Unzip all files to the TM1 Server's data directory:
	a) zChoreInfo.xdi
	b) zCubeInfo.xdi
	c) zDimensionInfo.xdi
	d) zProcessInfo.xdi
	e) TM1pedia.xls

2) In Perspectives, open and compile the 4 .xdi files

3) Create cubes:
	a) zChoreInfo
		i) }Chores
		ii) zChoreInfo
	a) zCubeInfo
		i) }Cubes
		ii) zCubeInfo
	a) zDimensionInfo
		i) }Dimensions
		ii) zDimensionInfo
	a) zProcessInfo
		i) }Processes
		ii) zProcessInfo

Use
==========================================================================

1) Log into TM1 as an administrator
2) Open TM1pedia.xls
3) On the "BUILD" tab, expand the grouped rows and columns to change the TM1 Server name in cell A2

NOTE: Ensure the server name entered includes the ":" character

3) On the "BUILD" tab, click on the [DO ALL] button
4) Wait for the macros to finish running

5) Use the Index tabs to navigate to specific cubes, dimensions, processes or chores

How the sheet works
==========================================================================

1) CMaster (and cube templates)
	a) DESCRIPTION
		* Free form text
		* Used to summarise the basis for the cube
	b) POPULATION Method
		* "TI", "MANUAL", "DBS" etc.
		* If this equals "TI", proper hyperlinks are generated in range O17:O36
		* For all other content, empty hyperlinks are generated in range O17:O36
	c) POPULATION Name
		* TI process name or free form text
		* If method equals "TI", full TI process name
		* For all other method content, free form text e.g. "MANUAL" "Entered via input templates by users"
	d) RULES
		* Free form text
		* Used to summarise any rules present on the cube
	e) VIEWS Name
		* Free form text
		* Used to list any popular views or those used by TI processes
	f) VIEWS Usage
		* Free form text
		* Used to summarise the usage of these views



2) DMaster (and dimension templates)
	a) DESCRIPTION
		* Free form text
		* Used to summarise the basis for the dimension
	b) POPULATION Method
		* "TI", "XDI", "DIM" etc.
		* If this equals "TI", proper hyperlinks are generated in range O17:O36 to process tabs
		* If this equals "XDI", proper hyperlinks are generated in range O17:O36 to .xdi files
		* For all other content, empty hyperlinks are generated in range O17:O36
	c) POPULATION Name
		* TI process name, XDI file path or free form text
		* If method equals "TI", full TI process name
		* If method equals "XDI", full file path to .xdi file
		* For all other method content, free form text e.g. "DIM" "Modified via Dimension Editor"
	d) SUBSETS Name
		* Free form text
		* Used to list any popular subsets or those used by TI processes
	e) SUBSETS Usage
		* Free form text
		* Used to summarise the usage of these subsets
	f) The (?) button in cell K6 will present the WHERE USED DIMENSION tab and filter column H by the current dimension



3) PMaster (and process templates)
	a) DESCRIPTION
		* Free form text
		* Used to summarise the basis for the process
	b) SOURCE Type
		* "ODBC", "ASCII", "ODBO", "TM1", "SAP" or "None"
		* Used to denote the datasource type
	c) SOURCE Name 
		* ASCII file path or free form text
		* If type equals "ASCII", full file path to file
		* If type equals "DIM", dimension name (not subset)
		* If type equals "CUBE", cube name (not view)
		* For all other type content, free form text e.g. "ODBC" "MySQL"
	d) PARAMETERS
		* "YES" or "NO"
		* Used to indicate whether the process requires run-time parameters
	e) NOTES
		* Free form text
		* Used to summarise the actions performed by the process
	f) The (?) button in cell X17 will present the WHERE USED SOURCE tab and filter column H by the current ASCII source file
	


4) HMaster (and chore templates)
	a) DESCRIPTION
		* Free form text
		* Used to summarise the basis for the chore
	b) SCHEDULED
		* "YES" or "NO"
		* Used to indicate whether the chore is scheduled
	c) PROCESSES Name
		* Full TI process name
	d) PROCESSES Parameter
		* Returns the process PARAMETERS as above
		





















